home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / old-compression / clQueryAlgorithms.z / clQueryAlgorithms
Encoding:
Text File  |  2002-10-03  |  8.0 KB  |  133 lines

  1.  
  2.  
  3.  
  4. ccccllllQQQQuuuueeeerrrryyyyAAAAllllggggoooorrrriiiitttthhhhmmmmssss((((3333ddddmmmm))))                                  ccccllllQQQQuuuueeeerrrryyyyAAAAllllggggoooorrrriiiitttthhhhmmmmssss((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      clQueryAlgorithms, clQuerySchemeFromHandle, clQuerySchemeFromName,
  10.      clGetAlgorithmName, clQueryLicense - Get a list of algorithms, find the
  11.      identifier or name, or check for a license
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ccccllll....hhhh>>>>
  15.  
  16.      iiiinnnntttt ccccllllQQQQuuuueeeerrrryyyyAAAAllllggggoooorrrriiiitttthhhhmmmmssss((((iiiinnnntttt aaaallllggggTTTTyyyyppppeeee,,,, iiiinnnntttt ****bbbbuuuuffffffffeeeerrrr,,,, iiiinnnntttt bbbbuuuuffffffffeeeerrrrLLLLeeeennnnggggtttthhhh))))
  17.      iiiinnnntttt ccccllllQQQQuuuueeeerrrryyyySSSScccchhhheeeemmmmeeeeFFFFrrrroooommmmHHHHaaaannnnddddlllleeee((((CCCCLLLLhhhhaaaannnnddddlllleeee hhhhaaaannnnddddlllleeee))))
  18.      iiiinnnntttt ccccllllQQQQuuuueeeerrrryyyySSSScccchhhheeeemmmmeeeeFFFFrrrroooommmmNNNNaaaammmmeeee((((iiiinnnntttt aaaallllggggTTTTyyyyppppeeee,,,, ccccoooonnnnsssstttt cccchhhhaaaarrrr ****nnnnaaaammmmeeee))))
  19.      cccchhhhaaaarrrr ****ccccllllGGGGeeeettttAAAAllllggggoooorrrriiiitttthhhhmmmmNNNNaaaammmmeeee((((iiiinnnntttt sssscccchhhheeeemmmmeeee))))
  20.      iiiinnnntttt ccccllllQQQQuuuueeeerrrryyyyLLLLiiiicccceeeennnnsssseeee((((iiiinnnntttt sssscccchhhheeeemmmmeeee,,,, iiiinnnntttt ffffuuuunnnnccccttttiiiioooonnnnaaaalllliiiittttyyyy,,,, cccchhhhaaaarrrr ********mmmmeeeessssssssaaaaggggeeee))))
  21.  
  22. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  23.      _a_l_g_T_y_p_e        The algorithm type.  Possible values are CCCCLLLL____AAAALLLLGGGG____VVVVIIIIDDDDEEEEOOOO or
  24.                     CCCCLLLL____AAAALLLLGGGG____AAAAUUUUDDDDIIIIOOOO.
  25.  
  26.      _b_u_f_f_e_r         An array of ints into which ccccllllQQQQuuuueeeerrrryyyyAAAAllllggggoooorrrriiiitttthhhhmmmmssss writes
  27.                     name/functionality pairs.
  28.  
  29.      _b_u_f_f_e_r_L_e_n_g_t_h   The number of ints in _b_u_f_f_e_r.
  30.  
  31.      _h_a_n_d_l_e         A handle to a compressor or decompressor.
  32.  
  33.      _n_a_m_e           The algorithm name.
  34.  
  35.      _s_c_h_e_m_e         The scheme identifier.
  36.  
  37.      _f_u_n_c_t_i_o_n_a_l_i_t_y  The functionality provided by the scheme.  Possible values
  38.                     are
  39.                          CCCCLLLL____CCCCOOOOMMMMPPPPRRRREEEESSSSSSSSOOOORRRR    compression only
  40.                          CCCCLLLL____DDDDEEEECCCCOOOOMMMMPPPPRRRREEEESSSSSSSSOOOORRRR  decompression only
  41.                          CCCCLLLL____CCCCOOOODDDDEEEECCCC         compression and decompression
  42.  
  43.      _m_e_s_s_a_g_e        A pointer to a comment string returned by ccccllllQQQQuuuueeeerrrryyyyLLLLiiiicccceeeennnnsssseeee.
  44.  
  45. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  46.      ccccllllQQQQuuuueeeerrrryyyyAAAAllllggggoooorrrriiiitttthhhhmmmmssss is used to determine the list of recognized algorithms.
  47.      Name/functionality pairs are written into _b_u_f_f_e_r up to the capacity
  48.      _b_u_f_f_e_r_L_e_n_g_t_h.  The even entries receive the algorithm names, and the odd
  49.      entries receive the functionalities.
  50.  
  51.      ccccllllQQQQuuuueeeerrrryyyySSSScccchhhheeeemmmmeeeeFFFFrrrroooommmmHHHHaaaannnnddddlllleeee and ccccllllQQQQuuuueeeerrrryyyySSSScccchhhheeeemmmmeeeeFFFFrrrroooommmmNNNNaaaammmmeeee are used to obtain the
  52.      scheme identifier (e.g. CL_MVC1_SOFTWARE) from a handle or name.
  53.      ccccllllGGGGeeeettttAAAAllllggggoooorrrriiiitttthhhhmmmmNNNNaaaammmmeeee gives the name from the scheme identifier.
  54.  
  55.      ccccllllQQQQuuuueeeerrrryyyyLLLLiiiicccceeeennnnsssseeee is called to check for the installation of a NetLS license
  56.      for the specified _s_c_h_e_m_e and _f_u_n_c_t_i_o_n_a_l_i_t_y.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ccccllllQQQQuuuueeeerrrryyyyAAAAllllggggoooorrrriiiitttthhhhmmmmssss((((3333ddddmmmm))))                                  ccccllllQQQQuuuueeeerrrryyyyAAAAllllggggoooorrrriiiitttthhhhmmmmssss((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  75.      ccccllllQQQQuuuueeeerrrryyyyAAAAllllggggoooorrrriiiitttthhhhmmmmssss returns the size of the buffer, in number of ints,
  76.      needed to hold all of the algorithms of the requested type.  (If
  77.      _b_u_f_f_e_r_L_e_n_g_t_h is smaller than this value, a partial list of algorithms is
  78.      filled in.)  On failure, a negative error code is returned.
  79.  
  80.      ccccllllQQQQuuuueeeerrrryyyySSSScccchhhheeeemmmmeeeeFFFFrrrroooommmmHHHHaaaannnnddddlllleeee and ccccllllQQQQuuuueeeerrrryyyySSSScccchhhheeeemmmmeeeeFFFFrrrroooommmmNNNNaaaammmmeeee return the compression
  81.      scheme identifier, or a negative error code on failure.
  82.      ccccllllGGGGeeeettttAAAAllllggggoooorrrriiiitttthhhhmmmmNNNNaaaammmmeeee returns the string name, or NULL on failure.
  83.  
  84.      ccccllllQQQQuuuueeeerrrryyyyLLLLiiiicccceeeennnnsssseeee returns SUCCESS if the license is installed or not needed,
  85.      and returns a negative error code otherwise.
  86.  
  87.  
  88. EEEEXXXXAAAAMMMMPPPPLLLLEEEE
  89.           #include <dmedia/cl.h>
  90.  
  91.           int *buffer, bufferLength;
  92.           CLhandle handle;
  93.           char *name, *message;
  94.            ...
  95.           /* Find all the video algorithms */
  96.           bufferLength = clQueryAlgorithms(CL_ALG_VIDEO, NULL, 0);
  97.           buffer = (int *) malloc(bufferLength * sizeof(int));
  98.           clQueryAlgorithms(CL_ALG_VIDEO, buffer, bufferLength);
  99.            ...
  100.           /* Other calls */
  101.           scheme = clQuerySchemeFromHandle(handle);
  102.           scheme = clQuerySchemeFromName(CL_ALG_VIDEO, name);
  103.           name = clGetAlgorithmName(scheme);
  104.           clQueryLicense(CL_MULTIRATE_AWARE, CL_CODEC, &message);
  105.  
  106.  
  107. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  108.      CLintro(3dm), clAddAlgorithm(3dm), clQueryParameters(3dm)
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.